Skip to main content
Version: 5.2

User Group Service

UserGroupDto : OrganizationUnitDto

This class defines a group of users such as team, department or branch. Each group has group leader and zero to n assistants.

DatatypeNameDescription
StringGroupNameUnique Name of the Group (unique in combination with the group type)
GroupTypeGroupTypeDefines the type of the group (e.g. Team, Department or Branch)
UserProfileDtoGroupLeaderLeader of the defined group
List \<UserGroupMemberDto>GroupMembersGroup Members
boolHasOwnTaxDataTrue, if the user group has it's own tax data
Guid?ParentUserGroupIdId of the parent user group, or null if the parent is the headquarter

UserGroupMemberDto : UserGrouSaveMemberDto

This class contains the data from loading group members. The class is derived from the UserGroupSaveMemberDto class.

DatatypeNameDescription
StringGroupNameName of the group where the member belongs to.

UserGrouSaveMemberDto

This class contains all data that is necessary to save group members. The class is derived from the UserProfileDto class.

DatatypeNameDescription
Guid?GroupIdId of the group to that the user belongs
GroupTypeGroupTypeType of the group to that the group belongs.
GroupMemberTypeMemberTypeDefines the type of the group member (e.g. Member or Assistant)
BoolIsDeletedTrue, if the user shall removed from the group
BoolIsPrimaryGroupTrue, if the group is the primary group for the user (eg. Primary group is used for holiday requests)

UserGroupSearchDto : PagingContextDto

This class offers properties to search for user groups. This class is derived from the PagingContextDto.

DatatypeNameDescription
StringGroupNameName of the user group to search for.
GroupTypeGroupTypeType of the user group to search for (or undefined to search all group types)
BoolEnrichWithMembersTrue, if the group members shall be included within the result.

UserGroupDto

Diese Klasse definiert eine Benutzergruppe wie Team, Abteilung oder Niederlassung. Jede Gruppe hat dabei einen Gruppenleiter und 0 bis n Assistenten.

DatatypeNameDescription
StringGroupNameUnique Name of the Group (unique in combination with the group type)
GroupTypeGroupTypeDefines the type of the group (e.g. Team, Department or Branch)
UserProfileDtoGroupLeaderLeader of the defined group
List\<UserGroupMemberDto\>GroupMembersGroup Members

UserGroupMemberDto : UserGrouSaveMemberDto

Diese Klasse enthält alle Daten die beim Laden von Gruppenmitgliedern gefüllt sind. Die Klasse ist abgeleitet von der UserGroupSaveMemberDto Klasse.

DatatypeNameDescription
StringGroupNameName of the group where the member belongs to.

UserGroupSaveMemberDto

Diese Klasse enthält alle Daten die beim Speichern eines Gruppenmitglieds benötigt werden. Sie ist abgeleitet von der UserProfileDto Klasse.

DatatypeNameDescription
Guid?GroupIdId of the group to that the user belongs
GroupTypeGroupTypeType of the group to that the group belongs.
GroupMemberTypeMemberTypeDefines the type of the group member (e.g. Member or Assistant)
BoolIsDeletedTrue, if the user shall removed from the group
BoolIsPrimaryGroupTrue, if the group is the primary group for the user (eg. Primary group is used for holiday requests)

UserGroupSearchDto : PagingContextDto

Die Klasse enthält die Eigenschaften mit denen die Gruppen gesucht werden. Die Klasse ist vom PagingContextDto abgeleitet.

DatatypeNameDescription
StringGroupNameName of the user group to search for.
GroupTypeGroupTypeType of the user group to search for (or undefined to search all group types)
BoolEnrichWithMembersTrue, if the group members shall be included within the result.
List\<Guid\>GroupIdsList of group ids to search